Skip to main content

Fetch Performance Metrics Details

Overview

The Performance Metrics APIs provide access to dashboards, widgets, and metric data collected by Motadata ObserveOps. These endpoints allow you to retrieve both real-time and historical performance data for monitors, instances, and groups.

Performance metric data is organized into two levels:

  • Dashboard & Widget APIs — Retrieve available dashboards and the widgets configured within them.
  • Metric Query APIs — Query time-series or aggregated metric values for specific counters and entities.

Available Endpoints

MethodEndpointDescription
GET/visualization/dashboardsRetrieve all available performance metrics dashboards.
GET/visualization/dashboards/{id}Retrieve all widgets associated with a specific dashboard by its ID.
GET/visualization/widgets/{id}Retrieve details of a specific widget (name, category, timeline, chart properties).
GET/query/visualization/{id}Retrieve KPI metric values for a specific widget.
POST/query/metric/histogramRetrieve historical time-series data for a single metric counter.
POST/query/metric/aggregationsRetrieve aggregated metric data (avg, sum, min, max, count) for multiple counters.

To retrieve performance metrics data end-to-end, follow this sequence:

  1. List Dashboards — Call GET /visualization/dashboards to find the dashboard you need.
  2. Get Widgets — Call GET /visualization/dashboards/{id} using the dashboard ID to get the widget list.
  3. Identify Widget — Call GET /visualization/widgets/{id} to confirm the widget name and type.
  4. Fetch Metrics — Call GET /query/visualization/{id} for current KPIs, or use the histogram/aggregation POST endpoints for historical and aggregated data.

Metric Counter Types

Motadata ObserveOps supports two types of metric counters:

  • Scalar Counters — Single-value metrics such as CPU percentage, memory usage, or disk read bytes. Results are returned per monitor.
  • Instance Counters — Multi-instance metrics such as network interface throughput or disk partition usage. Results are returned per monitor and per instance.

Authentication

All endpoints require a valid session cookie or API token. Unauthorized requests receive a 403 Forbidden response.